Hybris UX Api

List billingAccount (TMF666)

/billingAccount

[GET]

This operation retrieves a billing account entity using msisdn or account No.

URL

https://[localhost]:[port]/ecom-ux/v1/{businessId}/billingAccount

URL Params

Headers

Query Param

[GET] Retrieve Account Details By MSISDN/ACCOUNT NO. Response

[
  {
    "id": "969221000100",
    "accountType": "R",
    "description": "Residencial",
    "paymentStatus": "Active",
    "state": "W-Working",
    "name": "Mr John Doe",
    "accountBalance": [
      {
        "amount": {
          "value": 0,
          "unit": "JMD"
        },
        "balanceType": "DepositRequired"
      },
      {
        "amount": {
          "value": 0,
          "unit": "JMD"
        },
        "balanceType": "DepositHeld"
      },
      {
        "amount": {
          "value": 0,
          "unit": "JMD"
        },
        "balanceType": "LastPayment Amount",
        "validFor": {
          "endDateTime": "2025-06-30T00:00:00.000-05:00"
        }
      },
      {
        "amount": {
          "value": 0,
          "unit": "JMD"
        },
        "balanceType": "Overdue Amount"
      }
    ],
    "billStructure": {
      "cycleSpecification": {
        "id": "U",
        "paymentDueDate": "2025-07-12T00:00:00.000-05:00"
      },
      "presentationMedia": [
        {
          "id": "E",
          "name": "Electronic Bills"
        }
      ]
    },
    "contact": [
      {
        "contactName": "John Doe",
        "contactMedium": [
          {
            "mediumType": "BillingAddress",
            "characteristic": {
              "street1": "35",
              "street2": "sullivan avenue",
              "city": "KINGSTON",
              "stateOrProvince": "ST.ANDREW",
              "postCode": "00006"
            }
          },
          {
                    "mediumType": "Email",
                    "characteristic": {
                        "contactType": "Email",
                        "emailAddress": "johndoe@gmail.com"
                    }
           }
        ]
      }
    ]
  },
  {
    "paymentPlan": [
      {
        "priority": 0,
        "planType": "C"
      }
    ]
  },
  {
    "relatedParty": [
      {
        "id": "4555245",
        "name": "Mr John Doe",
        "role": "Customer",
        "@referredType": "Individual",
        "individualIdentification": [
                {
                    "identificationId": "4555245",
                    "identificationType": "TR"
                }
        ],
        "title": "Mr",
        "givenName": "John",
        "legalName": "Doe",
        "birthDate":"1996-09-22T00:00:00.000-05:00"
      },
    {
                    "id": "1",
                    "name": "Salvatore",
                    "@referredType": "Organization"
    }
    ]
  },
  {
    "defaultPaymentMethod": {
      "id": "E",
      "name": "Electronic"
    }
  }
]

Response Data Model:

Each of the response parameters is detailed.

Keyconsiderations

Liberty Caribbean Markets Implementation

AccountNo. & MSISDN Usecase

- This is implemented for postpaid and prepaid customers for LC market.
- Mandatory queryParams to retrieve available Billing Account Details: id or relatedParty.id
    - pass valid number for "id" or "relatedParty.id".